Keycloak REST Services 1.5.0-Final

Path: / admin / realms / {realm} / user-federation / instances / {id} / mappers / {id}

Get mapper

Path parameters:
realm - realm name (not id!)
id -
id - mapperId

Resource Methods
Method Summary
NameDescription
GET /admin/realms/{realm}/user-federation/instances/{id}/mappers/{id}Get mapper
PUT /admin/realms/{realm}/user-federation/instances/{id}/mappers/{id}Update mapper
DELETE /admin/realms/{realm}/user-federation/instances/{id}/mappers/{id}Delete mapper with given ID

Method Detail

GET /admin/realms/{realm}/user-federation/instances/{id}/mappers/{id}

Get mapper

HTTP Example:
GET /admin/realms/{realm}/user-federation/instances/{id}/mappers/{id}
API Example:

UserFederationProviderResource.getMapperById({'realm': /* name realm name (not id!) */,
  'id': …,
  'id': /* id mapperId */});

Output:
UserFederationMapperRepresentation -
Produces:
application/json

PUT /admin/realms/{realm}/user-federation/instances/{id}/mappers/{id}

Update mapper

HTTP Example:
PUT /admin/realms/{realm}/user-federation/instances/{id}/mappers/{id}
API Example:

UserFederationProviderResource.update({'realm': /* name realm name (not id!) */,
  'id': …,
  'id': /* id */,
  '$entity': /* rep */});

Input:
UserFederationMapperRepresentation
Output:
void
Consumes:
application/json

DELETE /admin/realms/{realm}/user-federation/instances/{id}/mappers/{id}

Delete mapper with given ID

HTTP Example:
DELETE /admin/realms/{realm}/user-federation/instances/{id}/mappers/{id}
API Example:

UserFederationProviderResource.delete({'realm': /* name realm name (not id!) */,
  'id': …,
  'id': /* id */});

Output:
void

Keycloak REST Services 1.5.0-Final